AWS CLI で API Gateway のリソースが見つからないときの対処方法

AWSテクニカルサポートノート

#AWS

#Amazon API Gateway

#REST API

#HTTP API

hato

2023.11.02

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

困っていた内容

AWS CLI で API Gateway（REST API）のリソース情報を取得したいです。
AWS マネジメントコンソールからは確認できますが、CLI ではNotFoundExceptionになりました。
AWS CLI でリソース情報を取得する方法を教えてください。

$ aws apigatewayv2 get-vpc-link --vpc-link-id abcd123

An error occurred (NotFoundException) when calling the GetVpcLink operation: Invalid Vpc Link identifier specified

どう対応すればいいの?

apigatewayv2の代わりにapigatewayを指定してください。

$ aws apigateway get-vpc-link --vpc-link-id abcd123

API Gateway は AWS CLI でも操作できますが、API 種別（REST API/HTTP API/WebSocket API）によって使用するコマンドが異なります。

API Gateway REST API はコマンドでapigateway（API V1）を使用し、
API Gateway HTTP API/API Gateway WebSocket API はapigatewayv2（API V2）を使用します。

aws <コマンド> <サブコマンド> [オプションやパラメータ]

同じサブコマンド名で V1 と V2 それぞれ用意されている場合もあるので、エラーの際は正しいバージョンのコマンドを指定しているか確認してください。

また、リソースが表示されない場合、一般的な観点として AWS CLI のアカウント ID やリージョン設定が正しいかもご確認ください。

参考資料

Announcing HTTP APIs for Amazon API Gateway | AWS Compute Blog

There are currently two API Gateway namespaces for managing API Gateway deployments. The API V1 namespace represents REST APIs and API V2 represents WebSocket APIs and the new HTTP APIs.